home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / mach10.zip / SYSOP.DOC < prev    next >
Text File  |  1990-07-26  |  18KB  |  410 lines
  1. Mach-10 Documentation
  2. ---------------------
  3.  
  4.        This documentation is no where near complete, but for those people who
  5. want to try to set up Mach-10, I've tried to put together enough information
  6. to get you started with a minimum of difficulty. Since this system is complex
  7. and barely documented, I am suggesting that only EXPERIENCED SYSOPS attempt
  8. setting up Mach-10.
  9.  
  10.        Basically, Mach-10 is your average bulletin board system. It offers a
  11. few specialized features that other boards do not offer, and adds a lot of
  12. flexibility that other BBS programs do not have. Here are some of Mach-10's
  13. main features:
  14.  
  15.            - Compatible with both the FIDO (.MSG) message format and my
  16.              proprietary HP (High Performance) message system.
  17.  
  18.            - Completely flexible and redefinable menu structure. You may
  19.              have as many menus as you like with any options you want on
  20.              them.
  21.  
  22.            - Control file setup. 99% of Mach-10's configuration is done from
  23.              a control file. This make Mach-10 easily configurable with a
  24.              simple text editor.
  25.  
  26.            - Built in call analizer and statistics functions. There are a
  27.              variaty of built in statistics commands that allow the users to
  28.              see how the system is doing.
  29.  
  30.            - Remote/Local file maintenance section. Mach-10 offers many file
  31.              maintenance routines that allow the sysop to move, delete,
  32.              zip, view, etc files locally or remotely.
  33.  
  34.            - PackMail system. The PackMail system allows users to bundle
  35.              their messages and download them for offline reading.
  36.  
  37.            - Full screen editor. The Full screen editor is the same as that
  38.              used by Prodoor, written by Sam H. Smith.
  39.  
  40.            - Powerful message system - The message system includes ReadLocks,
  41.              marked messages, searching and scanning, and many other powerful
  42.              features.
  43.  
  44.            - Built in CD-ROM capability for using the RBBS-IN-A-BOX CD-ROM.
  45.              We're going to add other CD-ROM's as I get them, but currently
  46.              the RBBS-IN-A-BOX is the only thing I have tested.
  47.  
  48.            - Sysop message reader. I have included my HPReader package which
  49.              is a powerful offline messaage reader, compatible with both the
  50.              FIDO and HP formats.
  51.  
  52.            - HP format tosser. If you elect to go with the HP message format,
  53.              you can use my HPUTIL message tosser. It functions exactly like
  54.              ConfMail/Qmail/etc and tosses into my proprietary message
  55.              format. (Note: The HP format is not manditory - Mach-10 is fully
  56.              compatible with the standard FIDO format)
  57.  
  58.            - Multinode compatibility - Mach-10 is fully multinode compatible
  59.              (I run a two-node system myself) - Mach-10 includes a built-in
  60.              multinode chat command.
  61.  
  62.            - Compatible with any doors that use the DORINFOx.DEF format. This
  63.              means you can run virtually any door program. (Converters are
  64.              available to run Pcboard, Wildcat, WWIV, etc doors)
  65.  
  66.            - Written in Pascal for efficient code. Turbo Pascal offers overlay
  67.              support which allows Mach-10 to keep a portion of its code on
  68.              disk and only load necessary code on demand. Saves memory!
  69.  
  70.            - Advanced file catalog - stores more information than most
  71.              other bbs programs - uploader name, times downloaded, etc.
  72.  
  73.            - Powerful conferences - The conferences allow you to set up
  74.              multiple bbs environments. Each conference may have it's own
  75.              message areas, file areas, bulletins, menus, etc.
  76.  
  77.            - Extensive user information - Much data is kept on the user -
  78.              including statistical information, security parameters, alias,
  79.              mailing address, etc.
  80.  
  81.        I suppose the next thing I ought to get to in these docs is the files
  82. that I have included in the package. Here they are:
  83.  
  84. Included files
  85. --------------
  86.  
  87.     MACH10.EXE   - Main executable file for Mach-10
  88.     MACH-1.CTL   - Sample Mach-1 control file (node #1)
  89.     EDITOR.EXE   - Mach-10 external editor (not fully completed)
  90.  
  91.  -- EXEBBS.BAT   - Sample Frontdoor EXEBBS.BAT to run Mach-10
  92.  :  FDOOR.BAT    - Sample Frontdoor FDOOR.BAT to run Mach-10 (and process mail)
  93.  -- AREAS.BBS    - My sample AREAS.BBS
  94.  :
  95.  :---------------- NOTE: These sample files are set up for my HP format
  96.                    message system. (non-fido)
  97.  
  98.     FILETRAN.BAT - File transfer protocol batch file
  99.     BATCHTRA.BAT - Batch protocol file transfer batch file
  100.     SIMUL.BAT    - Simultanious transfer protocl batch file
  101.  
  102.     MACHARC.BAT  - Zip/Zoo/Lzh/Arc/Pak archive support batch file
  103.  
  104.     CALLBAC1    \
  105.     CALLBAC2     > Autocallback text files
  106.     CALLBAC3    /
  107.  
  108.     MENU.ZIP     - Sample Mach-10 menu files
  109.     BULLET.ZIP   - Sample Mach-10 bulletins
  110.     HELP.ZIP     - Sample Mach-10 help files
  111.     WELCOME.ZIP  - Sample Mach-10 welcome files
  112.  
  113.     COMMON.PAS   - Pascal source code for Mach-10 variable structures
  114.  
  115.     HPREADER.*   - My external message reader (Docs, CTL, and EXE)
  116.  
  117.     SYSOP.DOC    - Sysop documentation (this file)
  118.     FLINKS.DOC   - Partial (incomplete) list of Mach-10 command services
  119.  
  120.     TWARS.BAT    - Sample external door batch file
  121.     TWARS2.BAT   - Sample external door batch file
  122.     WWIII.BAT    - Sample internal door batch file
  123.  
  124.     MACHRET.BAT  - File to return to Mach-10 after an external door
  125.  
  126.  
  127. Files that Mach-10 will create
  128. ------------------------------
  129.  
  130.     ARCPACKx.M10 - Packaged user mail (archived ver)
  131.     ANALIZEx.M10 - Call analizer data file
  132.     CALLERSx.M10 - Callers file (plain text)
  133.     CHAT.M10     - Multiuser chat data file
  134.     DORINFOx.DEF - Door information file
  135.     FILECAT.M10  - Files system file catalog
  136.     NODES.M10    - Node status information
  137.     PACKx.M10    - Packaged user mail (plain-text ver)
  138.     USERS.M10    - User file (holds all user data)
  139.  
  140.     (NOTE: Filenames with a small "x" in them indicate that the "x" is a
  141.      node number (i.e. "1", "2", etc)
  142.  
  143. MY SETUP
  144. --------
  145.        In order for you to understand how things work, I have included the
  146. control file and batch files directly from my bbs. Here's a basic run-down
  147. of what the disk structure on my node #1 looks like:
  148.  
  149.  
  150.  
  151.   I:\ -------- MACH10 ---------------- MENU     (Menu files         )
  152.          :               :
  153.          :               ------------- HELP     (Help files         )
  154.          :               :
  155.          :               ------------- BULLET   (Bulletins          )
  156.          :               :
  157.          :               ------------- WELCOME  (Welcome files      )
  158.          :               :
  159.          :               ------------- MISCTEXT (Misc. text files   )
  160.          :               :
  161.          :               ------------- TWARS    (Galactic Warzone #1)
  162.          :               :
  163.          :               ------------- TWARS2   (Galactic Warzone #2)
  164.          :
  165.          :
  166.          ----- SCOTTBBS -------------- EXTPROTO (External protocols )
  167.          :
  168.          :
  169.          ----- CDROM     (CD-ROM support)
  170.          :
  171.          :
  172.          ----- BINKLEY --------------- NODELIST (Nodelist files     )
  173.                          :
  174.                          ------------- MESSAGES (Messages           )
  175.  
  176.  
  177.        The five ZIP files I have included can go directly into their
  178. respective directories (MENU,HELP,BULLET,WELCOME,MISCTEXT). Most of the other
  179. junk should go into the Mach-10 directory. You'll probably be installing
  180. into a drive other than I: so you'll need to edit the Mach-10 control
  181. file (MACH-1.CTL) to reflect your changes.
  182.        Although my mailer's directory is called BINKLEY, I am actually
  183. running FRONT-DOOR. I have included my FDOOR.BAT, EXEBBS.BAT, and AREAS.BBS
  184. files from my system.
  185.        A few more things you might be interested in - I have a 2400 baud
  186. modem and it is plugged into COM1. I am running a color (EGA) system.
  187.  
  188. THE CONTROL FILE
  189. ----------------
  190.        Read the control file! It has information that is more important than
  191. what is in here!
  192.  
  193. NOTES ABOUT MACH-10
  194. -------------------
  195.        Since I am rushing these docs, I am going to write down a series of
  196. general important things below. The points below are not in any specific
  197. order, but they are all more or less important.
  198.  
  199. CONTROL FILE
  200.  
  201.        The Mach-10 control file (Mach-1.ctl) contains much information that
  202. is not present in this document. Read it! It is important!
  203.  
  204. CALLING UP MACH-10
  205.  
  206.        99.9% of the time Mach-10 requires a node-number as the first parameter
  207. on the command line. (This is not a FIDONET node number, but a node number as
  208. in networking). For most purposes, this will be a "1". Examples:
  209.  
  210.                    MACH10 1 /L           Local Logon
  211.                    MACH10 1 /S           Sysop Logon
  212.                    MACH10 1 /M           Message renumbering
  213.  
  214. FRONT-END
  215.  
  216.        The front end (i.e. binkley or front door) is necessary for the
  217. operation of Mach-10. Mach-10 itself has no routines for answering the phone,
  218. the Front-end handles answering the phone, processing any mail, etc. If you
  219. already are using a bbs program that uses a front-end, then setting it up
  220. should be a breaze. If not, then you should probably stop now and acquire
  221. a front-end and set it up before proceding.
  222.  
  223. RENUMBERING
  224.  
  225.        Mach-10 needs to renumber it's messages on a nighty basis. You will
  226. need to set up an EVENT from your Front-End to exit sometime during the night
  227. and in a batch file perform the following options in this order:
  228.  
  229.        1) Somehow delete old messages. Confmail version 3.x will handle
  230.           this nicely. DO NOT renumber yet
  231.  
  232.        2) Go into the Mach-10 directory and run Mach-10 with the /M switch
  233.           (i.e. MACH10 1 /M). Mach-10 will then adjust all of the user's
  234.           lastread pointers.
  235.  
  236.        3) Now, do the actual renumbering. Confmail version 3.x will also
  237.           handle this nicely.
  238.  
  239.        There is one way in which Mach-10 will perform all of the above
  240. procedures itself. In this mode, uncomment the "SHELLTOCONFMAIL" parameter
  241. in the in Mach-10. Then, Mach-10 will shell and run confmail to do steps
  242. 1 and 3. All you will need to do then is step #2. (run Mach-10 with the
  243. /M parameter)
  244.  
  245.        1) You must have a copy of your AREAS.BBS in you mach-10 directory,
  246.           along with any other files that confmail needs.
  247.  
  248.        2) Confmail must either be in the Mach-10 directory or accessable
  249.           with the dos path command.
  250.  
  251.        3) You must be using confmail version 3.x, not 4.x.
  252.  
  253. MULTINODE USE
  254.  
  255.        Mach-10 is fully multinode capable. Each node will require a seperate
  256. control file (Mach-1.ctl, Mach-2.ctl, Mach-3.ctl, etc) and you may need
  257. a seperate copy of the EXE file for each node.
  258.  
  259. EDITER.EXE
  260.  
  261.        Editor.Exe is the Mach-10 external sysop editor. It includes a file
  262. and user editor, and an event editor (although the Mach-10 does not support
  263. events at this time).
  264.        The file and user editors are very useful and slightly more
  265. powerful to the internal ones built into Mach-10.
  266.  
  267. EXTERNAL PROTOCOLS
  268.  
  269.        I use DSZ.EXE for most of my protocols, but also use BIMODEM, CLINK,
  270. PCKERMIT, and a few others. The external protocols are all called through
  271. one of three batch files: Filetran.bat, batchtra.bat, or simul.bat. Look
  272. at these files for more information.
  273.  
  274. INTERFACE BATCH FILES
  275.  
  276.        Several batch files are included which I call "interface batch files".
  277. These files handle the interface between Mach-10 and various other
  278. necessary files. This includes mainly the external file transfer protocols
  279. and the ZIP/ARC/LZH/ZOO/PAK support. Here are the batch files and what
  280. they do:
  281.  
  282.        MACHARC.BAT
  283.  
  284.           This batch file provides support for various archiving programs.
  285.           Mach-10 will pass a command to the batch file and then the
  286.           batch file operates on the command. Commands include ARC viewing,
  287.           testing, converting to ZIPs, etc.
  288.  
  289.        FILETRAN.BAT
  290.  
  291.           This file handles all non-batch transfers. You may have to edit
  292.           this file to change various path's to reflect your system.
  293.  
  294.        BATCHTRA.BAT
  295.  
  296.           This file handles all batch protocol transfers. (i.e. Batch zmodem,
  297.           ymodem-batch, etc)
  298.  
  299.        SIMUL.BAT
  300.  
  301.           Simul.bat is a special file for handling BIMODEM simultanious
  302.           transfers.
  303.  
  304. DOORS
  305.  
  306.        The control file includes a lot of information on both external and
  307. shelled doors, but I will add a closer more in-depth look here. Basically,
  308. Mach-10 uses the DORINFOx.DEF method of passign door parameters. (The DORINFO
  309. method is also used by RBBS, QUICKBBS, and other bbs programs).
  310.        Mach-10 will create a DORINFOx.DEF when ever it shells or exits to
  311. a door. The "x" stands for the node number and will usually be "1" in most
  312. (non-multinode) situations. DORINFOx.DEF contains almost all necessary
  313. information for operating the door - The user's first and last name,
  314. baud rate, etc.
  315.        Mach-10 also passes some parameters on the command line to the batch
  316. file. This includes the Baud, Time left, a "0", the user's first and
  317. last name, and the graphics the user has selected. For ANSI graphics,
  318. Mach-10 will send a "1" for non-ANSI, mach-10 will send a "0".
  319. For example, suppose we were calling TWARS.BAT, John Doe was online at 2400
  320. baud, had 30 minutes left, and was running ANSI. Mach-10 would execute the
  321. following: "TWARS.BAT 2400 30 0 JOHN DOE 1". The parameters in most cases
  322. are not necessary, but if you need to write custom door interfaces yourself,
  323. these parameters could make your job a bit easier.
  324.        For shelled doors (see the control file), Mach-10 simply shells and
  325. executes the command line above. For external doors, the process is a bit
  326. more complicated.
  327.  
  328. EXTERNAL DOORS
  329.  
  330.        External doors are doors that Mach-10 must exit to rather than shell
  331. to because they require too much memory to be run shelled. Mach-10 implements
  332. external doors through a batch file type system. A special file called
  333. "MACHDOR"+(node num)+'.BAT' will be created containing the same command
  334. line that Mach-10 would have executed for a shelled door. Your EXEBBS.BAT
  335. must then execute the MACHDORx.BAT file which in turn executes the
  336. door batch file, and then executes the batch file MACHRETx.BAT.
  337.        All of this can best be explained with an example. Suppose you
  338. were running my Galactic Warzone door game externally. Again, suppose that
  339. John Doe was on at 2400 baud with ansi graphics and 30 mins of time.
  340.  
  341. [------ EXEBBS.BAT, MACH-10.BAT, or whatever calls Mach-10 -----]
  342. cd \MACH10                              ; Change to Mach-10 dir
  343. if exist MACHDOR1.BAT del MACHDOR1.BAT  ; Kill old bat if present
  344. MACH10 1 %2 %1                          ; Run Mach-10
  345. if exist MACHDOR1.BAT MACHDOR1.BAT      ; Run the bat if it exists
  346. cd \fdoor                               ; Get back to frontdoor dir
  347. fdoor                                   ; Run front-doors bat file
  348. [---------------------------------------------------------------]
  349.  
  350.  
  351. [------ MACHDOR1.BAT -------------------------------------------]
  352. TWARS.BAT 2400 30 0 JOHN DOE 1          ; Run the door batch file
  353. [---------------------------------------------------------------]
  354.  
  355.  
  356. [------ TWARS.BAT ----------------------------------------------]
  357. cd \mach10\twars                        ; Get into my GW directory
  358. copy \mach10\dorinfo1.def               ; Copy over the dorinfo
  359. twars 1                                 ; Run GW with node #1
  360. cd \mach10                              ; Get back to Mach-10 directory
  361. MACHRET.BAT                             ; Return to Mach-10
  362. [---------------------------------------------------------------]
  363.  
  364.  
  365. [------ MACHRET.BAT --------------------------------------------]
  366. cd \fdoor                               ; Get to front-door dir
  367. EXEBBS.BAT 255 255                      ; Reload Mach-10
  368.                                         ; The 255's tell Mach-10 we are
  369.                                         ; returning from a door
  370. [---------------------------------------------------------------]
  371.  
  372. NOTE: The ";" comments are invalid in batch files, but I added them to this
  373.       document for clarity.
  374.  
  375.        EXEBBS.BAT is the batch file that is used to run Mach-10. The
  376. front end mailer (i.e. Front-Door or Binkley) runs this file with the
  377. baud rate and comport on the command line. (i.e. "EXEBBS.BAT 2400 1")
  378. This file must delete the existing MACHDORx.BAT file if it is present,
  379. runs Mach-10, and if Mach-10 creates a MACHDORx.BAT file, then Mach-10
  380. executes it.
  381.        The last file, MACHRET.BAT requires some additional explanation. What
  382. it does is call up EXEBBS.BAT which in turn loads Mach-10 (node #1) again,
  383. but with the parameters 255 and 255 as the baud rate and com port. When these
  384. two variables are set to 255, Mach-10 recognizes that we are returning from
  385. an external door and re-loads the user data and correct baud/comport
  386. information from it's own data files.
  387.  
  388. MULTINODE AND DOORS
  389.  
  390.        Most doors only support one node at a time (My Galactic Warzone
  391. included). Therefore, you must either only have these doors on one node or
  392. work up some kind of scheme to keep users from trying to go into the same
  393. door at the same time from different nodes. Here are a few cautions for
  394. using doors on a multinode system.
  395.  
  396.        1) Mach-10 will create different DORINFOx.DEF and MACHDORx.BAT for
  397.           different nodes.
  398.  
  399.        2) You will probably need a seperate EXEBBS.BAT for each node.
  400.  
  401.        3) You will probably need a seperate MACHRET.BAT for each node.
  402.  
  403. LOCAL LOGON
  404.  
  405.        You may log into Mach-10 locally with the "/L" switch. You must also
  406. specify the node umber as the first parameter on the command line. For
  407. example: "MACH10 1 /L".
  408.        There is also a special sysop fast-logon option. The "/S" parameter
  409. will log the sysop on and bypass the majority of the services during logon.
  410. For example: "MACH10 1 /S".